Docs For Class UserRoleManagement

UserRoleManagement

Description

Located in /roleplay/classes/class.userrolemanagement.inc.php (line 33)

Method Summary

UserRoleManagement UserRoleManagement (int $courseID)

boolean assignUsersToRole (int $roleID, array $users)

mixed getRolesOfUser (int $userID, [ $onlyActive = false])

mixed getUsersWithRole (int $roleID)

bool setActiveUserRole (int $userID, int $roleID)

bool setRoleForUser (int $userID, int $roleID, [bool $setActive = false])

void showRoleAssignmentForms ()

void showRolesOverview ()

void showUserRoleForm (int $userID)

void showUsersOverview ()

bool unsetRoleForUser (int $userID, int $roleID)

Methods

Constructor UserRoleManagement (line 57)

Konstruktor.

access: public

UserRoleManagement UserRoleManagement (int $courseID)

int $courseID: ID des Kurses, für den die Benutzer-Rollen verwaltet werden sollen

assignUsersToRole (line 116)

Ordnet alle im Array angegebenen Benutzer-IDs der angegebenen Rolle zu.

Bestehende Zuordnungen von Benutzern, die nicht im Array enthalten sind, werden gelöscht.

return: Erfolgswert
access: public

boolean assignUsersToRole (int $roleID, array $users)

int $roleID: ID der Rolle, zu der die Benutzer zugeordnet werden sollen
array $users: Array von Benutzer-IDs, die der Rolle zugeordnet werden sollen

getRolesOfUser (line 236)

Gibt die dem angegebenen Benutzer zugewiesenen Rollen in einem Array zurück.

return: Zweidimensionales Array mit der Rollen-ID als Schlüssel und den Werten isActive und dem Rollenobjekt role oder false bei ungültiger User-ID
access: public

mixed getRolesOfUser (int $userID, [ $onlyActive = false])

int $userID: ID des Benutzers, dessen Rollen zurückgegeben werden sollen
$onlyActive

getUsersWithRole (line 92)

Gibt die IDs der Benutzer zurück, die die übergebene Rolle innehaben.

Ob der Benutzer gerade in dieser Rolle aktiv ist, wird hier nicht überprüft.

return: Array mit den Benutzer-IDs (int) oder false, falls die Rollen-ID ungültig ist
access: public

mixed getUsersWithRole (int $roleID)

int $roleID: ID der Rolle, für die die Benutzer zurückgegeben werden sollen

setActiveUserRole (line 305)

Setzt die angegebene Rolle für den Benutzer aktiv, alle anderen inaktiv.

Wird 0 als Rollen-ID übergeben, werden alle Rollen des Benutzers auf inaktiv gesetzt

return: Erfolgswert
access: public

bool setActiveUserRole (int $userID, int $roleID)

int $userID: ID des Benutzers, dessen Rolle gesetzt werden soll
int $roleID: ID der Rolle, die für den Benutzer aktiv gesetzt werden soll

setRoleForUser (line 171)

Ordnet eine Rolle einem User zu.

return: Erfolgswert
access: public

bool setRoleForUser (int $userID, int $roleID, [bool $setActive = false])

int $userID: User-ID
int $roleID: Rollen-ID
bool $setActive: Gibt an, ob die neue Rolle auch aktiv gesetzt werden soll.

showRoleAssignmentForms (line 67)

Gibt für jede Rolle aller in diesem Kurs aktiven Rollen-Sets eine select-Box aus, in der aus allen Kurs-Mitgliedern ausgewählt werden kann, wer der Rolle zugeordnet ist.

access: public

void showRoleAssignmentForms ()

showRolesOverview (line 360)

Gibt eine Übersicht der Rollen und den zugeordneten Teilnehmern in Listenform aus.

access: public

void showRolesOverview ()

showUserRoleForm (line 265)

Zeigt das Formular an, mit dem der Benutzer eine der ihm zugewiesenen Rollen aktivieren kann.

access: public

void showUserRoleForm (int $userID)

int $userID: ID des Benutzers, dessen Rollen ausgegeben werden sollen

showUsersOverview (line 331)

Gibt eine Übersicht der Teilnehmer und den ihnen zugeordneten Rollen in Listenform aus.

access: public

void showUsersOverview ()

unsetRoleForUser (line 200)

Entfernt die Rollenzuordnung eines Users.

return: Erfolgswert
access: public

bool unsetRoleForUser (int $userID, int $roleID)

int $userID: User-ID
int $roleID: Rollen-ID

Documentation generated on Sat, 07 Nov 2009 00:28:55 +0100 by phpDocumentor 1.4.3